Check VA Info
Path
- URL:
/cb-core/api/v1/va/check-info - Method:
POST - Description: This API allows users to send requests to check information of a Virtual Account
Request
Request Table
| Params | Data Type + Length | Required | Description |
|---|---|---|---|
| request_id | string(50) | Yes | Unique request ID, suggested format: MerchantCode+YYYYMMDDHHMMSS+UniqueId |
| request_time | string(19) | Yes | Format: YYYY-MM-DD HH:MM:SS |
| merchant_code | string(20) | Yes | Merchant code provided by Baokim before integration |
| reference_code | string(100) | Yes | The reference code of VA managed in your system |
Request Example
{
"request_id": "PARTNER12320231105123000ID01",
"request_time": "2023-11-05 12:30",
"merchant_code": "PARTNER123",
"reference_code": "ORDER12345"
}
Response
Response Table
| Params | Data Type + Length | Required | Description |
|---|---|---|---|
| response_code | int(4) | Yes | Error code from Baokim as per Error Codes Table |
| response_message | string(100) | Yes | Description of the error code from Baokim as per Error Codes Table |
| merchant_code | string(20) | Yes | Merchant code provided by Baokim before integration |
| reference_code | string(100) | Yes | The reference code of VA managed in your system |
| status | int(1) | Yes | 1: Active; 2: Inactive |
| expire_date | string(19) | Yes | Format: YYYY-MM-DD HH:MM:SS |
| account_info | object | Yes | Virtual account details |
| account_info.bank_name | string(100) | Yes | Bank name |
| account_info.bank_no | string(6) | Yes | Bank no |
| account_info.bank_branch | string(100) | Yes | Bank branch |
| account_info.acc_no | string(22) | Yes | Bank account number |
| account_info.acc_name | string(63) | Yes | Account holder's name |
| account_info.qr | string(100) | Yes | QR string encoded with base64 |
| account_info.qr_path | string(100) | Yes | QR image path |
Response Example
{
"response_code": 200,
"response_message": "Success",
"merchant_code": "BAOKIM",
"reference_code": "ORD12345678901234567890345",
"status": 1,
"expire_date": "2024-12-31 23:59",
"account_info": {
"bank_name": "Nguyen Van A",
"bank_no": "963336",
"bank_branch": "Main Branch",
"acc_no": "12345678901234567890",
"acc_name": "John Doe",
"qr": "SGVsbG8sIFdvcmxkIQ==",
"qr_path": "/path/to/qr/image.png"
}
}
Error Code
| Response Code | Response Message |
|---|---|
| 200 | Success |
| 99 | Pending |
| 11 | Failed |
| 101 | System Error |
| 110 | Merchant Code Invalid |
| 120 | Invalid Signature |
| 422 | Validation Error |
| 1100 | Virtual account does not exist |